IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/SignPluginTask

SignPluginTask

@CacheableTask

abstract class SignPluginTask : JavaExec, SigningAware

Signs the ZIP archive with the provided key using Marketplace ZIP Signer library.

To sign the plugin before publishing to JetBrains Marketplace with the SignPluginTask task, it is required to provide a certificate chain and a private key with its password using IntelliJPlatformExtension.Signing extension.

As soon as privateKey (or privateKeyFile) and certificateChain (or certificateChainFile) properties are specified, the task will be executed automatically right before the PublishPluginTask task.

For more details, see Plugin Signing article.

See also

Marketplace ZIP Signer

Constructors

constructor()

Types

object Companion : Registrable

Properties

@get:InputFile

@get:SkipWhenEmpty

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val archiveFile: RegularFileProperty

Input, unsigned ZIP archive file. Refers to in CLI option.

certificateChain

@get:Input

@get:Optional

abstract val certificateChain: Property<String>

A string containing X509 certificates. The first certificate from the chain will be used as a certificate authority (CA). Refers to cert CLI option.

certificateChainFile

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val certificateChainFile: RegularFileProperty

Path to the file containing X509 certificates. The first certificate from the chain will be used as a certificate authority (CA). Refers to cert-file CLI option.

conventionMapping

@get:Internal

val conventionMapping: ConventionMapping

@get:Internal

var enabled: Boolean

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

val javaLauncher: Property<JavaLauncher>

val jvmArguments: ListProperty<String>

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val keyStore: RegularFileProperty

KeyStore file. Refers to ks CLI option.

keyStoreKeyAlias

@get:Input

@get:Optional

abstract val keyStoreKeyAlias: Property<String>

KeyStore key alias. Refers to ks-key-alias CLI option.

keyStorePassword

@get:Input

@get:Optional

abstract val keyStorePassword: Property<String>

KeyStore password. Refers to ks-pass CLI option.

keyStoreProviderName

@get:Input

@get:Optional

abstract val keyStoreProviderName: Property<String>

JCA KeyStore Provider name. Refers to ks-provider-name CLI option.

@get:Input

@get:Optional

abstract val keyStoreType: Property<String>

KeyStore type. Refers to ks-type CLI option.

val mainClass: Property<String>

val mainModule: Property<String>

val modularity: ModularitySpec

@get:Input

@get:Optional

abstract val password: Property<String>

Password required to decrypt the private key. Refers to key-pass CLI option.

@get:Input

@get:Optional

abstract val privateKey: Property<String>

Encoded private key in the PEM format. Refers to key CLI option.

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val privateKeyFile: RegularFileProperty

A file with an encoded private key in the PEM format. Refers to key-file CLI option.

signedArchiveFile

@get:OutputFile

abstract val signedArchiveFile: RegularFileProperty

Output, signed ZIP archive file. Refers to out CLI option.

val state: TaskStateInternal

val timeout: Property<Duration>

zipSignerExecutable

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val zipSignerExecutable: RegularFileProperty

Path to the Marketplace ZIP Signer executable.

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

open override fun args(vararg args: Any): JavaExec

open override fun args(args: MutableIterable<*>): JavaExecSpec

bootstrapClasspath

open override fun bootstrapClasspath(vararg classpath: Any): JavaExec

open override fun classpath(vararg paths: Any): JavaExec

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<Any>): Task

conventionMapping

open fun conventionMapping(property: String, mapping: Closure<Any>): Task

open fun conventionMapping(property: String, mapping: Callable<*>): Task

open override fun copyTo(options: JavaForkOptions): JavaExec

open override fun copyTo(target: ProcessForkOptions): JavaExec

open override fun debugOptions(action: Action<JavaDebugOptions>)

open override fun dependsOn(vararg paths: Any): Task

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

open override fun environment(environmentVariables: MutableMap<String, *>): JavaExec

open override fun environment(name: String, value: Any): JavaExec

open override fun exec()

open override fun executable(executable: Any): JavaExec

open override fun finalizedBy(vararg paths: Any): Task

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAllJvmArgs(): MutableList<String>

open override fun getAnt(): AntBuilder

open override fun getArgs(): MutableList<String>?

getArgumentProviders

open override fun getArgumentProviders(): MutableList<CommandLineArgumentProvider>

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

getBootstrapClasspath

open override fun getBootstrapClasspath(): FileCollection

open override fun getClasspath(): FileCollection

@Internal

open override fun getCommandLine(): MutableList<String>

@Internal

open override fun ~~getConvention~~(): Convention

open override fun getDebug(): Boolean

getDebugOptions

open override fun getDebugOptions(): JavaDebugOptions

getDefaultCharacterEncoding

open override fun getDefaultCharacterEncoding(): String?

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

getEnableAssertions

open override fun getEnableAssertions(): Boolean

@Internal

open override fun getEnvironment(): MutableMap<String, Any>

@Internal

open override fun getErrorOutput(): OutputStream

@Internal(value = "covered by getJavaVersion")

open override fun getExecutable(): String?

getExecutionResult

@Internal

open fun getExecutionResult(): Provider<ExecResult>

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

@Input

open fun getJavaVersion(): JavaVersion

open override fun getJvmArgs(): MutableList<String>?

getJvmArgumentProviders

open override fun getJvmArgumentProviders(): MutableList<CommandLineArgumentProvider>

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

open override fun getMaxHeapSize(): String?

open override fun getMinHeapSize(): String?

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardInput

@Internal

open override fun getStandardInput(): InputStream

getStandardOutput

@Internal

open override fun getStandardOutput(): OutputStream

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

getSystemProperties

open override fun getSystemProperties(): MutableMap<String, Any>

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

@Internal

open override fun getWorkingDir(): File

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

isIgnoreExitValue

@Input

open override fun isIgnoreExitValue(): Boolean

open override fun jvmArgs(vararg arguments: Any): JavaExec

open override fun jvmArgs(arguments: MutableIterable<*>): JavaExec

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

open override fun property(propertyName: String): Any?

open override fun setActions(replacements: MutableList<Action<in Task>>)

open override fun setAllJvmArgs(arguments: MutableIterable<*>)

open override fun setAllJvmArgs(arguments: MutableList<String>)

open override fun setArgs(applicationArgs: MutableIterable<*>?): JavaExec

open override fun setArgs(applicationArgs: MutableList<String>?): JavaExec

open fun setArgsString(args: String): JavaExec

setBootstrapClasspath

open override fun setBootstrapClasspath(classpath: FileCollection)

open override fun setClasspath(classpath: FileCollection): JavaExec

open override fun setDebug(enabled: Boolean)

setDefaultCharacterEncoding

open override fun setDefaultCharacterEncoding(defaultCharacterEncoding: String?)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDescription(description: String?)

open override fun setDidWork(didWork: Boolean)

setEnableAssertions

open override fun setEnableAssertions(enabled: Boolean)

open override fun setEnvironment(environmentVariables: MutableMap<String, *>)

open override fun setErrorOutput(outputStream: OutputStream): JavaExec

open override fun setExecutable(executable: Any)

open override fun setExecutable(executable: String)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

open override fun setGroup(group: String?)

setIgnoreExitValue

open override fun setIgnoreExitValue(ignoreExitValue: Boolean): JavaExecSpec

open override fun setJvmArgs(arguments: MutableIterable<*>?)

open override fun setJvmArgs(arguments: MutableList<String>?)

@ReplacedBy(value = "mainClass")

open fun ~~setMain~~(@Nullable main: String?): JavaExecSpec

open override fun setMaxHeapSize(heapSize: String?)

open override fun setMinHeapSize(heapSize: String?)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

setStandardInput

open override fun setStandardInput(inputStream: InputStream): JavaExec

setStandardOutput

open override fun setStandardOutput(outputStream: OutputStream): JavaExec

setSystemProperties

open override fun setSystemProperties(properties: MutableMap<String, *>)

open override fun setWorkingDir(dir: File)

open override fun setWorkingDir(dir: Any)

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

systemProperties

open override fun systemProperties(properties: MutableMap<String, *>): JavaExec

open override fun systemProperty(name: String, value: Any): JavaExec

open override fun usesService(service: Provider<out BuildService<*>>)

open override fun workingDir(dir: Any): JavaExec